home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 98 / Skunkware 98.iso / src / x11 / misc / xfmail-1.0.README < prev    next >
Text File  |  1997-08-26  |  9KB  |  263 lines
  1. $Id: README,v 1.43 1996/12/19 14:39:30 gena Exp $
  2.  
  3.                   XFMail - XForms based mail reader for the
  4.                              X-Windows system
  5.  
  6.                          Release 1.0 Patchlevel 0
  7.  
  8. Copyright (c) 1995, 1996
  9.   Gennady B. Sorokopud (gena@NetVision.net.il)
  10.  
  11. Copyright (c) 1995
  12.   Ugen J. S. Antsilevich (ugen@latte.worldbank.org)
  13.  
  14.  Please read the Copyright file included in the distribution.
  15.  
  16. Special thanks to:
  17.  
  18. Dr. T.C. Zhao and Mark Overmars 
  19.     For their excellent XForms toolkit 
  20. Iain Lea <root@mail.bricbrac.de>
  21.     For his suggestions/bug reports
  22. Gregg Jensen <gwj@stl.nexen.com>
  23.     For helping me make XFMail more bug-free
  24. Thomas Pundt <pundtt@escher.uni-muenster.de>
  25.     For threading and PGP support and other useful stuff
  26. Graham Biswell <graham@tarka.demon.co.uk> and
  27. Simon Shapiro <Shimon@i-Connect.Net>
  28.     For sound support and many useful suggestions
  29. Sam Trenholme <set@netcom.com>
  30.     For spending his time on eliminating many malicious bugs in
  31.     XFMail
  32. Marc van Kempen <marc@bowtie.nl>
  33.     For writing the scrollable editor widget.  This great piece of code
  34.     is the final step in making XFMail a fully functional e-mail client!
  35. Erik Berry <berry@colossus.mathcs.rhodes.edu>
  36.     For his great work on xfmail documentation. Now we can actually
  37.     read it!
  38.  
  39. Also i would like to thank all of the people who helped me debug XFMail
  40. by submitting bug reports, and also those who help make it more powerful
  41. by sending me many useful suggestions.
  42.  
  43. Well done guys!
  44.  
  45.  
  46.         OVERVIEW
  47.  
  48. XFMail is an X-Windows application for sending and receiving electronic mail.
  49. It uses the XForms GUI library toolkit by T.C. Zhao and Mark Overmars.
  50.  
  51. It is partially compatible with mh style mailboxes but does not require any
  52. mh tools to be installed on the system.  You can browse your mh folders and
  53. messages using XFMail.
  54.  
  55. It has a user-friendly interface and online help to make it easy to use.
  56. It implements most of the mail functionality in one program and it does not
  57. require any additional tools.
  58.  
  59. The package was tested on:
  60.  
  61.  - FreeBSD-2.x running XFree86-3.1
  62.  - Linux-1.2.2 and Linux-2.0 running XFree86-3.1.1 and XFree86-3.2
  63.    (and also on Linux/Alpha)
  64.  - SunOS 4.1.3_U1 and 4.1.4 running OpenWindows.
  65.  - Solaris-2.4 & 2.5 running OpenWindows.
  66.  - HPUX-10.01 running X11R5
  67.  - IRIX-5.x
  68.  - DEC OSF1 v. 3.2
  69.  - Pyramid DC/OS
  70.  - AT&T SVR4.0.4
  71.  - AIX-3.2.5
  72.  - UnixWare-2.1
  73.  - NetBSD
  74.  - BSDI-2.1
  75.  
  76. The development environment is FreeBSD.
  77.  
  78. For the list of changes since 0.1-beta see the Changelog file included in the
  79. distribution. (Also check out the KNOWNBUGS file included in the distribution)
  80.  
  81. XFMail's main features:
  82.  
  83.  - A user friendly interface
  84.  - Full MIME support
  85.  - Configuration via internal dialog windows, instead of dotfiles
  86.  - Retrieves mail from both POP servers and the local mail spool
  87.  - Smart POP features
  88.  - Mail can be sent using sendmail, an SMTP gateway, or a POP server 
  89.  - Support for IMAP4 remote folders
  90.  - Multiple address books with mailing list support
  91.  - Flexible message filtering rules
  92.  - Support for faces and picons
  93.  - Multiple signatures with attachment rules
  94.  - Multi-lingual support
  95.  - PGP support
  96.  - Many other little nice features; just take a look!
  97.  
  98.  
  99.         WHERE TO GET IT
  100.  
  101. You can FTP XFMail as:
  102.    ftp://ftp.x.org/contrib/applications/xfmail-1.0.tar.gz
  103.    ftp://Burka.NetVision.net.il/pub/xfmail/xfmail-1.0.tar.gz
  104.  
  105. Take a look at XFMail's homepage: 
  106. http://Burka.NetVision.net.il/xfmail/xfmail.html
  107.  
  108.  
  109.         REQUIREMENTS
  110.  
  111. In order to successfully compile XFMail on your system you need:
  112.  
  113.  - The XForms0.81 library and include files.  XForms for different platforms
  114. could be obtained from: ftp://laue.phys.uwm.edu/pub/xforms
  115. As an alternative, you can get the pre-compiled libforms.a/so library for 
  116. different platforms and the forms.h file from:
  117. ftp://Burka.NetVision.net.il/pub/xfmail
  118.  
  119.  - The Xpm library.  This is included with most recent operating systems with
  120. X-Windows, but it can be obtained from:
  121. ftp://ftp.x.org/contrib/libraries/libXpm-*.tar.gz
  122.  
  123. Also you will need the GNU C compiler (gcc or compatible) to be installed on
  124. your system.
  125.  
  126.  
  127.         INSTALLATION
  128.  
  129. You can ftp pre-compiled binaries for the above systems from:
  130. ftp://Burka.NetVision.net.il/pub/xfmail/<platform>
  131.  
  132. If you want to compile the package by yourself:
  133.  
  134.  - First install the XForms toolkit library:
  135. gzip -d bxforms-<platform>.tgz
  136. tar -xf xforms.tar
  137.  
  138.  - If you have root access on the system then
  139. su
  140. cd xforms
  141. make install
  142.  - If you don't have root access, go ahead and compile XForms, but you will
  143.    have to change the location that XFMail looks for the libforms.a and
  144.    forms.h files in a few steps (this is done in the Makefile).
  145.  
  146. (on FreeBSD you can just get the ready package - xforms-0.81.tgz
  147. and then run pkg_add xforms-0.81.tgz)
  148.  
  149.  - Unpack the xfmail.tar.gz archive with:
  150. gzip -d xfmail.tar.gz
  151. tar -xf xfmail.tar
  152.  
  153.  - Go to the xfmail/ui directory.
  154. cp Makefile.<your platform> Makefile
  155.  
  156.  - On Solaris, uncomment this line in compface/Makefile:
  157. #SYSV           = -DSYSV32 
  158.    Also if you're using Solaris 2.5 or later comment/uncomment
  159.    regex specific lines in the Makefile (see Makefile comments for
  160.    more details).
  161.  
  162.  - You also need to uncomment the stated line in regex/Makefile and
  163.    compface/Makefile
  164.  
  165. Change any system-dependent settings in Makefile to match your system
  166. configuration (read the Makefile itself for more information).  If XForms
  167. is in an unusual place you need to point Makefile to it.
  168.  
  169.  - Type:
  170. make
  171.  
  172. - If all goes well, you will soon have an xfmail binary in the ui/ directory.
  173.   To install the XFMail binary and man page (xfmail.1) system-wide, type:
  174. make install
  175.  
  176.  - To run XFMail, type:
  177. xfmail
  178.  
  179.    You don't need any additional files besides XFMail's binary (xfmail)
  180.    to run the program.
  181.  
  182.                 UPGRADE NOTES
  183.  
  184. Warning! If you're upgrading from older versions of XFMail you need
  185. to remove all folder cache directories. If you don't do that XFMail
  186. can crash and even corrupt your folders. In order to remove the cache
  187. directories, look for .cache/ directory in each directory located under
  188. ~/Mail. If such directory exists - remove it with rm -rf .
  189.  
  190. It's recommended to backup your address book(~/.xfbook) and filtering
  191. rules file (~/.xfmrules) before upgrading.
  192.  
  193. During the upgrade you will be asked if you want to keep your old
  194. configuration file. The recommended answer is "No", it's better
  195. to reconfigure XFMail since old parameters (especially placement and
  196. such) can become invalid.
  197.  
  198.         PORTING TO ANOTHER SYSTEM
  199.  
  200. XFMail can be easily ported to any Unix platform with the X-Windows
  201. system, XForms, and the Xpm libraries. It contains little system
  202. dependent code.  As far as I know, the only problematic points might be:
  203.  
  204.  - mmap system call in mail/fmail.c (mmap is for faster access to messages)
  205.  
  206.    (most of the mmap calls can be disabled by undefining MMAP_MSG
  207.     in mail/fmail.h)
  208.  
  209. To port it:
  210.  
  211.  - Create your own Makefile in the ui/ directory (like Makefile.mysystem).
  212.  - Make all the appropriate #ifdef <mysystem> changes
  213.  - Send me the patches :-)
  214.  
  215.                 LIMITATIONS
  216.  
  217. As any other program XFMail has it's limitations (see mail/fmail.h
  218.  for more details). Here are the most important ones:
  219.  
  220. - Name of field in the message header can not be longer then
  221.    32 characters (MAX_FIELD_NAME_LEN).
  222.  
  223. - No more then 64 fields in header (MAX_FIELDS_IN_HDR).
  224.  
  225. - Non-folded field can not be longer then 512 bytes (MAX_FIELD_LEN).
  226.  
  227. - Folded field can not be longer then 32768 bytes (MAX_SPLIT_FIELD_LEN).
  228.  
  229. - Limit on number of recipients in To , Cc or Bcc lists is 1024
  230.    (MAX_ADDR_IN_FIELD).
  231.  
  232. - XFMail can not have more then 2047 messages in one folder (MAX_MSG_IN_FOLDER).
  233.  
  234. - XFMail can not have more then 127 folders (MAX_FOLDERS).
  235.  
  236. - XFMail can not handle messages bigger then 3Mb (MAX_MSG_LEN).
  237.  
  238. - XFMail's internal message viewer will not show more then 4096 lines of message   text (MAX_VIEWABLE_LINES) or 128Kb (MAX_VIEWABLE_SIZE).
  239.  
  240. - XFMail's internal editor can not edit more then 4096 lines (MAX_EDITABLE_LINES) or 64Kb (MAX_EDITABLE_SIZE).
  241.  
  242. - You can have no more then 10 different address books (MAX_BOOKS).
  243.  
  244. - Each address book can hold no more then 1023 addresses (MAX_ADDR_IN_BOOK).
  245.  
  246. - Each alias can hold no more then 100 recipients (MAX_ADDR_IN_ALIAS).
  247.  
  248. - No more then 64 filtering rules (MAX_RULES) are allowed.
  249.  
  250.         CONTACTS
  251.  
  252. Please send all your suggestions/opinions/patches to:
  253. Gennady B. Sorokopud <gena@NetVision.net.il>
  254.  
  255. There is also a mailing list for XFMail.  To subscribe, send mail to
  256. Majordomo@Burka.NetVision.net.il with the line "subscribe xfmail" in the
  257. message body (You can also subscribe/unsubscribe to/from mailing list
  258. using the XFMail help menu).
  259.  
  260. If you find any bugs please report them to:
  261. xfmail-bugs@Burka.NetVision.net.il
  262. or use the "Bug-report" option in the XFMail help menu.
  263.